Skip to contentSkip to conversation

Extending documentation

PATCH New Yoni Bettan 1 participant 3 messages Oct 24, 2019

lore
Share & tools
lore
#0 lore raw

cover Extending documentation

patch #1 is a regular PATCH
patch #2 is an RFC-PATCH

Yoni Bettan (2):
Rearranged the "Providing Feedback" section of README.md Added a guide for adding a new virtio device

 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 71 insertions(+), 19 deletions(-)
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
#1 lore raw

PATCH 1/2 Rearranged the "Providing Feedback" section of README.md

From: Yoni Bettan <[email protected]>

Just arranged the alignment and also updated bullet #5 to fit multiple commits instead of a single one.

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 41 insertions(+), 19 deletions(-)
README.md +41 -19
index 5ac84f9..f2fa5d0 100644
@@ -71,25 +71,47 @@ have any attachments.
 A patch can be generated and sent by cloning the spec repository,
 creating a commit, formatting it as a patch and then sending it.
 For example:
-<code>
-<p>
-git clone https://github.com/oasis-tcs/virtio-spec.git<br>
-... edit spec text, and save ...<br>
-<p>
-git commit -a<br>
-... describe the proposed change, in the following format:<br>
-single line summary<br>
-<br>
-detailed description, including motivation for the change<br>
-<br>
-Signed-off-by: Name &lt;email&gt;<br>
-... then save and close the editor ... <br>
-<p>
-git format-patch -o proposal1/ HEAD~1..<br>
-... generates a new directory proposal1/ and a file starting with 0001- ...<br>
-<p>
-git send-email [email protected] proposal1/0001-*
-</code>
+<ol>
+<li>
+  clone the repository using
+  <code> git clone https://github.com/oasis-tcs/virtio-spec.git </code><br>
+</li>
+
+<li>
+  edit spec text and save<br>
+</li>
+
+<li>
+  commit changes using
+  <code> git commit -a</code> 
+  and describe the proposed change, in the following format:<br>
+  <br>
+  single line summary<br>
+  <br>
+  detailed description, including motivation for the change<br>
+  <br>
+  Signed-off-by: Name &lt;email&gt;<br>
+  <br>
+</li>
+
+<li>
+  save and close the editor<br>
+</li>
+
+<li>
+  create the patch using 
+  <code>
+    git format-patch -o proposal1/ HEAD~N
+  </code> 
+  - it will generates a new directory 'proposal1/' and a files starting with '0001-...' based on the last N commits of your git log <br>
+
+<li>
+  send the patch using 
+  <code>
+    git send-email [email protected] proposal1/0001-*
+  </code>
+</li>
+</ol>
 <h4>Note for TC Members</h4>
 <p>TC Members should review TC specific
 process rules under "Further Description of this Repository"
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
#2 lore raw

PATCH 2/2 Added a guide for adding a new virtio device

In reply to Yoni Bettan

From: Yoni Bettan <[email protected]>

This guide should give a pattern to create and implement a new virtio device in QEMU-KVM with example for each one of the 3 main parts:
* the specification
* the device
* the linux driver

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
README.md +30 -0
index f2fa5d0..bf85e4f 100644
@@ -146,6 +146,36 @@ Fixes: https://github.com/oasis-tcs/virtio-spec/issues/NNN
 and asking for a vote. </li>
 </ol>
 
+
+## Steps to create a new virtio device
+
+When creating a new device there are some steps we should follow:
+
+1. write the device specification
+    * merge it into the official virtio specification (this repository) as described
+      * `git clone git clone https://github.com/oasis-tcs/virtio-spec.git`
+      * add your device
+        * use [ybettan/virtio-spec/increment-edu branch][ybettan/virtio-spec/increment-edu branch] as reference
+      * send your patch to [email protected] (mailing list) for review
+   
+2. write the device implementation
+    * you can look at the example device at  [ybettan/qemu/virtio branch][ybettan/qemu/virtio branch] located in my fork of the Qemu project
+    * make sure to follow the full commit to find all other files related
+    * once it’s done, check the [wiki-qemu][wiki-qemu] for the full “how to contribute” to Qemu guide
+
+3. write the Linux driver for this device
+    * you can look at the example driver at  [ybettan/QemuDeviceDrivers-master branch][ybettan/QemuDeviceDrivers-master branch]
+    * in this repository, you have a README.md files describing how to compile the driver and use the device
+    * once it’s done, send the patch to this mailing list: [email protected]
+    
+    
+[ybettan/virtio-spec/increment-edu branch]: https://github.com/ybettan/virtio-spec/tree/increment-edu
+[ybettan/qemu/virtio branch]: https://github.com/ybettan/qemu/tree/virtio/hw/virtio
+[ybettan/QemuDeviceDrivers-master branch]: https://github.com/ybettan/QemuDeviceDrivers
+[wiki-qemu]: https://wiki.qemu.org/Contribute
+
+
+
 <h3>Contact</h3>
 <p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to <a href="mailto:[email protected]">Robin Cover</a> and <a href="mailto:[email protected]">Chet Ensign</a>.  For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the virtio TC's <a href="https://www.oasis-open.org/committees/virtio/">home page</a>.</p>
 </div>
Signature · 18 lines
2.21.0


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/